docs: design encrypted run artifacts#24
Merged
Merged
Conversation
- add #21 design covering key storage, artifact format, metadata visibility, purge behavior, migration, and tests - link the design from README and ROADMAP so the next implementation slice is obvious
There was a problem hiding this comment.
Pull request overview
This PR adds a concrete, implementation-oriented design doc for optional encryption of PII-bearing local run artifacts, and wires references to that design into the project’s README and roadmap to make Issue #21 actionable.
Changes:
- Adds
docs/security/run-artifact-encryption-design.mddescribing config, envelope format, touchpoints, migration, and tests for at-rest encryption of run artifacts. - Links the new design doc from the README’s security section.
- Adds an item to
ROADMAP.mdpointing Issue #21 to the drafted design.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| ROADMAP.md | Adds #21 roadmap entry referencing the new encryption design doc. |
| README.md | Links to the new encryption design doc from the security guidance section. |
| docs/security/run-artifact-encryption-design.md | Introduces the proposed design for encrypting sensitive run artifacts with AES-256-GCM and an artifact-store boundary. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+47
to
+48
| Protected files are written as an envelope with an `.enc.json` suffix: | ||
|
|
| runArtifacts: | ||
| encryption: | ||
| enabled: false | ||
| keyProvider: env # env | keychain-later |
|
|
||
| | Failure | Behavior | | ||
| |---|---| | ||
| | Encryption enabled but key missing | Abort before writing sensitive artifacts; explain `SOURCERER_ARTIFACT_KEY`. | |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Refs #21
Verification
Notes
This is the design/grounding pass, not the encryption implementation. The next PR should start with the crypto primitive + tests, then wire
candidates.jsonthrough an artifact store behind opt-in config.